home *** CD-ROM | disk | FTP | other *** search
/ Aminet 45 / Aminet 45 (2001)(GTI - Schatztruhe)[!][Oct 2001].iso / Aminet / game / role / ldmud-3.2-bin.lha / mud / doc / efun / command_stack < prev    next >
Text File  |  2001-02-21  |  1KB  |  32 lines
  1. SYNOPSIS
  2.         #include <commands.h>
  3.  
  4.         mixed * command_stack(void)
  5.  
  6. DESCRIPTION
  7.         Return an array describing the current command stack. The array has
  8.         command_stack_depth() entries, the first describing the top-level
  9.         command, and the last describing the current one.
  10.  
  11.         Each entry is an array itself with these entries:
  12.  
  13.           string [CMD_VERB]:    the verb of this command
  14.           string [CMD_TEXT]:    the full command text
  15.           object [CMD_ORIGIN]:  the original command giver
  16.           object [CMD_PLAYER]:  the current command giver
  17.           mixed  [CMD_FAIL]:    the notify_fail setting (or 0).
  18.           mixed  [CMD_FAILOBJ]: the object which set the notify_fail setting.
  19.  
  20.         CMD_ORIGIN and CMD_PLAYER are usually the same; there is a difference
  21.         only if the modify_command hook changes the command giver with
  22.         set_this_player().
  23.  
  24.         Note that any of the entries may be returned as 0.
  25.  
  26. HISTORY
  27.         Introduced in LDMud 3.2.7.
  28.         LDMud 3.2.8 added the CMD_FAILOBJ result.
  29.  
  30. SEE ALSO
  31.         command(E), command_stack_depth(E), notify_fail(E)
  32.